home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / mbln301.zip / DECCA.DOC < prev    next >
Text File  |  1996-01-27  |  7KB  |  144 lines
  1. DECCA, an user friendly interface to Compiled DECCA v1.20c Gamma
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. DECCA stands for Door-interface Embeded Command Compiler Advanced, it
  5. provides a simple way to interface with a door's ansi/avatar/tty formats.
  6. Note that DECCA is a true script compiler, and *not* a just a macro language!
  7.  
  8. DECCA now is slightly more intellegent stating where errors in the compile 
  9. can occur, and the tokens that produced them.
  10.  
  11. ──────────────────────────────────────────────────────────────────────────────
  12.  
  13.   A .DEC file might be:
  14.  
  15.   [| Test.dec, a simple example -- This is a comment btw |]
  16.   [lightblue]Hiya!  I'm in blue [blue]N[green]e[cyan]a[red]t[magenta]!
  17.   [cyan]And my phone number is: [phone][repeat][beep][10] and my work is: [workphone]
  18.   [hi]More [[Y/n]? [lo][anykey][readkey][choice]Y Yes
  19.   [choice]N No
  20.  
  21.   And there you go.  DECCA is designed mainly for myself, but I figured 
  22. I'd release it so that any sysop can custom configure the menus to their 
  23. tastes'. Note that you should not use ascii characters 25, 22, 21 as these
  24. are control codes for DECCA.  Stay away from them and there should be no 
  25. problem. I should note that DECCA can't have more than 1024 labels on 
  26. the go, so just make sure you don't approach that number of labels and 
  27. there won't be a problem.
  28.  
  29. ══════════════════════════════════════════════════════════════════════════════
  30.  
  31. Here's the current DECCA commands:
  32.  
  33. ────────────────────  Available Colour Commands  ─────────────────────────────
  34.  
  35.   BLACK              BLUE                GREEN              CYAN
  36.   RED                MAGENTA             BROWN              LIGHTGRAY
  37.   DARKGRAY           LIGHTBLUE           LIGHTGREEN         LIGHTCYAN
  38.   LIGHTRED           LIGHTMAGENTA        YELLOW             WHITE
  39.  
  40.   ── I hope you don't need explaination there, if you do these are the colours
  41.      that are standardly available for <colour> and <colour1> on <colour2>
  42.      commands.  There are also "LIGHTGREY" and "GREY", and "GRAY" all meaning 
  43.      the same as "LIGHTGRAY".  In addition there is "DARKGREY" which means
  44.      the same as "DARKGRAY". This is done to support Canadian & British 
  45.      spellings of these words.
  46.  
  47.                ──────══════  Miscelleneous  ══════──────
  48.  
  49. ────────────── DECCA non-specific commands (avatar codes) ────────────────────
  50.  
  51.   | Comment |            ── Commenting the code eg, [| This is a comment |]
  52.   CLS                    ── Clears Screen
  53.   BLINK                  ── Makes current colour blink
  54.   HI                     ── Turns on high intensity
  55.   LO                     ── Turns off high intensity
  56.   S                      ── Save current colour to memory
  57.   L                      ── Load colour from memory
  58.   UP                     ── Moves cursor up one position
  59.   DOWN                   ── Moves cursor down one position
  60.   LEFT                   ── Moves cursor left one position
  61.   RIGHT                  ── Moves cursor right one position
  62.   HOME                   ── Homes cursor
  63.   CLREOL                 ── Clear to end of line
  64.   BEEP                   ── Generates a beep
  65.   BS                     ── Backspaces once
  66.   CR                     ── Carriage return
  67.   LF                     ── Linefeed
  68.   ENTER                  ── New line
  69.   <Colour>               ── Changes colour to black, red, white whatever
  70.   <Colour1> ON <colour2> ── Changes colour to colour1 on background colour2
  71.   LOCATE <y> <x>         ── Locates the cursor to place y, x
  72.   REPEAT <Char> <times>  ── Repeats <char> <times> eg [repeat]H[7] or
  73.                             [repeat][beep][5] etc.  MUST be one character!
  74.   REPEATSEQ<length>string<times>
  75.                          ── Repeats String of length <length> <times> times
  76.   number                 ── Will make ASCII character number "number" 0..255
  77.  
  78.  
  79. ────────────────────── DECCA Specific Commands ───────────────────────────────
  80.  
  81.   ACCESS                 ── The users access (1..100)
  82.   ALIAS                  ── Displays user's alias
  83.   BAUDRATE               ── The users bps
  84.   CLEARINPUT             ── Clears keyboard and modem input
  85.   COMPORT                ── The comport being used
  86.   CITY                   ── Displays user's city
  87.   DATE                   ── Current date
  88.   ERASE<file><space>     ── Erases a file
  89.   EXECUTE<file><space>   ── Executes a .com or .exe (dos .exe)
  90.   FORCEINDEX<index><sp>  ── Forces an index number
  91.   GOSUB (label)          ── Jumps to a label, and return will return to the
  92.                             place of jump
  93.   GOTO (label)           ── Jumps to a label
  94.   IFKEYPRESSED           ── If keypressed then execute the rest of the line
  95.   IFINDEX<index><space>  ── Executes rest of the line if it's index <index>
  96.   LONGPAUSE              ── 1 Second pause
  97.   MOREON                 ── Turns moreprompting on (normally off)
  98.   MOREOFF                ── Turns moreprompting off (normally off)
  99.   NAME                   ── Displays user's name
  100.   NODE                   ── Displays current node number
  101.   PASSWORD               ── Displays user's password
  102.   PAUSE                  ── ½ Second pause
  103.   PHONE                  ── Displays user's phone number
  104.   REMAIN                 ── Remaining time in mins
  105.   SAVEPOS                ── Save position
  106.   RESTPOS                ── Restore position
  107.   SHORTPAUSE             ── ¼ Second pause
  108.   STUFFKEYS<keys><space> ── Stuffs keys into keyboard. Use | for enter.
  109.   TIME                   ── Current time
  110.   QUIT                   ── Quits dec file right there
  111.   WORKPHONE              ── The users work phone number
  112.   /LABEL                 ── Defines a label
  113.   RANDOM<stuff><space>   ── Stuffs a random character in the keyboard buffer
  114.                             to be read by readkey. Great kludge for playing
  115.                             with random choices.
  116.   RETURN                 ── Returns to the last gosub (implemented!)
  117.   IFEXIST<file> <rest>   ── Executes rest only if file exists
  118.   IFDEXIST<dir> <rest>   ── Same as ifexit, but with directories
  119.   READLN                 ── Reads 80 characters
  120.   IFENTERED<ch> <rest>   ── Check above
  121.   DISPFILE               ── Displays a file.. (DECCA *.EXE format)
  122.   MENU                   ── Sets choices for Readkey
  123.   ANYKEY                 ── Allows any key to be pressed for menu choice
  124.   MENUONLY               ── Allows only ones on the menu to be pressed
  125.   READKEY                ── Reads a key from the user
  126.   CHOICE<choice> <rest>  ── Executes rest of line only if statement concurs
  127.   LASTKEY                ── Writes lastkey stroke
  128.  
  129. @ -- Not impletemented.
  130.  
  131. ══════════════════════════════════════════════════════════════════════════════
  132.  
  133.   For a programmers reference to DECCA please address to: John Stephenson
  134.                                                           PO box 1573
  135.                                                           Kingston, Ont
  136.                                                           K7L 5C8, Canada
  137.  
  138.  
  139.   When DECCA is used in third party developers no roalty fee is anticipated,
  140. but if you decide to use the actual DECCA compiler included with your
  141. software please feel to give some netmail saying "Hey dude I'm using your
  142. DECCA script language for such and such, thank you for letting me use it
  143. for free!".
  144.